home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / renegade / filein56.zip / FILEIN!.DOC < prev    next >
Text File  |  1996-04-11  |  18KB  |  351 lines

  1.        FileIN! 5.6 Copyright 1996 by Chris Roberts and Patrick Spence
  2.                             All Rights Reserved.
  3.  
  4.  
  5. General Notes
  6. ─────────────
  7.     FileIN! is the answer to file importing problems with Renegade. This
  8.     utility will correctly import a TICK FILES.BBS to the appropriate *.DIR
  9.     file(RG directory). This extremely quick utility has many features that
  10.     make it the ideal addition to any Renegade system.
  11.  
  12.     It will check for dupes and make sure that the file to be imported does
  13.     reside in the currently directory. It will update extended descriptions
  14.     over 45 characters with a word wrap. BIOS writes can be forced over the
  15.     default direct video ram writes for certain multi-tasking environments.
  16.     It can optionally NOT purge the FILES.BBS file, if you wish to have
  17.     more than one BBS system use the same file directories, this option is
  18.     for you, as certain BBS systems read the FILES.BBS for the file
  19.     description info. It can also be used on a CD-ROM to import
  20.     descriptions.
  21.  
  22.     For users of Allfix, you do not need to have the description shoved all
  23.     on one line any longer. FileIN! will read the multi-line FILES.BBS, and
  24.     import up to 5 lines into the Renegade dir. 10 line importing will be
  25.     added as soon as Renegade supports it.
  26.  
  27.     FileIN! is intended for use by EXPERIENCED Renegade sysops. It is
  28.     possible to destroy data(incoming TIC files) now with improper setup of the
  29.     archive configuration. If you don't know what your doing, ask someone who
  30.     does. Patrick and I may be able to help, the number to Patrick's system
  31.     is at the end of this document.
  32.  
  33. Usage
  34. ─────
  35.  
  36. Usage is very straight-forward as follows:
  37.  
  38. FILEIN <path -AND- filename to a valid config file> <-I>
  39.  
  40. A -I in the commandline invokes IGNORE mode. More on this later.
  41.  
  42. Configuration
  43. ─────────────
  44.  
  45. Run FILECFG.EXE, and it will create a setup file in the current directory,
  46. The name of the config file can be user specifed, so there are now two running
  47. conventions for FILECFG.EXE
  48.  
  49. #1 : FILECFG
  50. #2 : FILECFG <path to RENEGADE.DAT> <name of config file to use>
  51.  
  52. The second running convention is for those of you who want one config file
  53. setup to import CD-ROMS, and another setup for normal imports. The name
  54. of the config file can be any valid DOS filename.
  55.  
  56. Option S is the Standard Options menu. The toggles are pretty straightforward.
  57. The menu is as follows:
  58.  
  59. (A) Swap(run FIN.BAT) <-FIN.BAT is described below, toggle this to YES
  60.                         if you wish to use a FIN.BAT
  61. (B) Purge FILES.BBS   <-If you wish to keep your FILES.BBS, toggle this to
  62.                         No, if its yes FileIN! will not delete it after
  63.                         finishing the current base.
  64. (C) Use BIOS for Video<-Pretty self-explanatory. BIOS writes are SLOW however.
  65. (D) Scan CD-ROM bases <-Normally, this should be NO, as CD-ROM drives are
  66.                         typically slow. You can turn this on to import the
  67.                         FILES.BBS of a rom disk you purchased.
  68. (E) Keep a Log Files  <-The log file contains start+stop times, and general
  69.                         info on the file bases and the files imported to those
  70.                         bases. The log now follows a binkley-style format.
  71. (F) Convert Archives  <-Info below, toggle yes if you wish to have them
  72.                         converted.
  73. (G) Custom Scan list  <-When toggled to yes, you can select which bases you
  74.                         want FileIN! to scan, which means faster runs. See
  75.                         below for instructions on how to set this up.
  76. (H) Files Uploaded by <-This can be "Sysop", your real name, or whatever you
  77.                         like. When you list files in renegade, it can display
  78.                         who originally uploaded the file. This text is placed
  79.                         in that field.
  80. (I) Registered to     <-Your name as it appears on the card with your serial
  81.                         number(assuming you've registered)
  82. (J) Serial Number     <-Your serial number(which you receive when you
  83.                         register.)
  84. (K) File list name    <-If left blank, defaults to FILES.BBS. For use with
  85.                         non-standard tic processors or wierd CD-ROMS.
  86.  
  87. (1) Path to RENEGADE.DAT <- I certainly hope you know what this is.
  88. (2) Swap Path            <- Ditto here.
  89.  
  90. Option A is the archive conversion setup. You CAN put the archivers in this
  91. menu, however FileIN! will not attempt to convert any archives unless you
  92. have a valid serial number(which you get by registering).
  93.  
  94. Working on Archive Entry #1
  95.  
  96. Remember: %F=Complete path+filename+extension
  97.           %W=Work Directory created at runtime
  98.           Success Errorlevel is generally zero.
  99.  
  100. (A) Extension ID:   <--This is the 3 char extension, ex: ZIP,ARJ,ZOO,SDN etc
  101. (B) Decompression Commandline: for Arj it would be 'ARJ E %F %W' or
  102.                                for an SDN it would be 'GUS %F %W'
  103.                                You MUST have GUS installed 'SDN' files.
  104.                                Do NOT insert a path here, the renegade
  105.                                archivers path is added automatically!!
  106. (C) Compression Commandline: again, for arj 'ARJ A %F %W'
  107.                              Do NOT insert a path here, the renegade
  108.                              archivers path is added automatically!!
  109. (D) Success Errorlevel: Zero for everything except PKPAK to my knowledge.
  110.                         For PAK/PKPAK set it to -1(ignore).
  111.  
  112. You can install up to ten archivers. Renegade has a maximum of eight, the
  113. extras are so you can convert the pointless *.SDN files that you receive in
  114. certain networks to a identifiable archive type(such as a ZIP or ARJ file).
  115. To setup the conversion of SDN's is very simple. You create an archive type
  116. with the extension ID of SDN, and the decompresssion commandline "GUS %F %W"
  117. You must have GUS(General Unpack Shell) to accomplish this. The compression
  118. commandline may be left blank, as it is usually unused for this type. You
  119. SHOULD use the /N(ignore imbedded directories) when using GUS, as if the
  120. archive is allowed to extract to a different directory, FileIN! will not
  121. find the files that were in the archive and the conversion will abort.
  122.  
  123. *** FileIN! converts archives to the type specified in the base setup inside
  124.     Renegade. If you (M)odify a file base inside renegade, it is option 8.
  125.     SDN's are converted by extracting with GUS as shown above, and then the
  126.     files are re-archived using the type you specified in your file base.
  127.  
  128. *** FileIN! does not change to the temp directory when creating an archive.
  129.     What this means is, your archive could end up with a directory structure
  130.     of 'D:\REN\FILE\ITCSDN\!FILEIN!.TMP\SAMPLE.XXX' on each file. To disable
  131.     this, add the appropriate option to the compression commandline. This is
  132.     one of those "Read the Docs" type things. For ARJ tho, put a -e in the
  133.     commandline.
  134.  
  135. FileIN! will convert an archive BEFORE it runs FIN.BAT, that is so you can
  136. convert the archives to whatever format you like, then extract the .DIZ and
  137. .SDI comment files(if any) from the archive, scan it, and add your bbs
  138. advertisement/comment to the archive.
  139.  
  140. FileIN! will NOT attempt to convert archive types on CD-ROM flagged bases.
  141. To futher that point, if you try to convert archives that are on a CD-ROM,
  142. unpredictable results could occur. I have done my best to check for things
  143. like this, but without a CD-ROM I can't be sure. I would highly suggest
  144. you NOT try it.
  145.  
  146. To go a bit further on CD-ROMs. If you have a CD-ROM that you are importing
  147. for the first time, you need to toggle "Scan CD-ROM bases" in Filecfg to YES.
  148. You will need to make a custom FIN.BAT that will extract the comment files
  149. to the UPLOAD path of the cd-rom base on your harddrive, not the current
  150. directory as you would normally do. If a file base is set with the CD-ROM
  151. flag, after running FIN.BAT it will search there for comment files. CD-ROM
  152. bases are passed a third paramater. %3 is the upload path for the current file
  153. base with a trailing '\', use that to extract comment files. %3 is ONLY
  154. passed when you are scanning a CD-ROM base.
  155.  
  156. When using a FIN.BAT or archive conversion, you should have the commandline
  157. that runs the archiver instuct it to assume YES on all queries. This is to
  158. prevent something like "File XXXX.XXX exists, overwrite?" from happening
  159. when FileIN! is spawned out, which would most likely hang your system all
  160. day.
  161.  
  162. FileIN! fully supports 4dos's memory(.BTM) batch files, just rename your
  163. FIN.BAT to FIN.BTM and make any necessary changes(4dos has many batch file
  164. enhancements).
  165.  
  166. Option M is the message posting setup. The menu is as follows:
  167.  
  168. (A)Message Posted by   : <-Typically sysop's name or "The Anonymous Announcer"
  169.                            etc.
  170. (B)Message Posted to   : <-All, My Users, etc etc
  171. (C)Message Subject     : <-"Newly Imported Files" or whatever.
  172. !!!!!!!!!!!!!!!!!
  173. (D)Scan Allfix bases   : !!!!!!!!!!!!DO NOT MESS WITH THIS YET!!!!!!!!!!!!
  174. !!!!!!!!!!!!!!!!!
  175. (E)Strip Pipe Codes    : Toggle to yes to make filein strip ALL pipe codes
  176.                          from posted messages.
  177. (F)Posting Active      : <-Toggle to YES to enable posting.
  178.  
  179. The message itself is slightly configurable on this release. The two text 
  180. files, HEADER.TXT, and FOOTER.TXT, go in the \MISC or \AFILES directory
  181. (if you dont know what this is, its in your renegade system config). You may
  182. edit these messages as you like, both support only TWO mci codes, time(%TI)
  183. and date(%DA). HEADER.TXT is imported before FileIN! begins scanning bases,
  184. FOOTER.TXT is imported just before the final tear line.
  185.  
  186. Option T is the Tag lists setup. This is where you tell FileIN! a little more
  187. about your systems setup. Note that ALL tag lists are optional, but that
  188. at least one TWO must be setup to use message posting, and 3 to use a custom
  189. tag list. The menu presents you with 5 choices, only the first 3 are active.
  190.  
  191. 1) File bases to scan during run
  192. 2) File bases to put in message
  193. 3) Bases to post message in
  194. 4) Allfix <reserved and not active>
  195. 5) Allfix <reserved and not active>
  196.  
  197. Tag list number one allows you to select which file bases you want filein to
  198. check for non-imported files. Usually, you specify only network bases on this
  199. list to make filein run faster. Note, if you set this list up, you must enable
  200. it by toggle "Use Custom Scan list" in the (S)ystem Configuration menu to YES.
  201.  
  202. Tag list two lets you pick only those bases that you want put in an 
  203. announcement message. You can leave off nodelist bases, general text, and the
  204. like to make your messages smaller. Note that these bases still get imported
  205. normally, the files simply don't get put into the announcement message.
  206.  
  207. Tag list three is totally new. Now that message posting is INTERNAL, you can
  208. have it post your message in as many bases as you like. I have it tagged to
  209. post in my local new files received base, as well as a network base used for
  210. new file announcements. You can tag as many bases as you like.
  211.  
  212. As with all tag lists, you can use alt-T and alt-U to turn all bases ON or OFF
  213. respectively. Hitting space will toggle any single base on or off, and a small
  214. box denotes those bases tagged ON.
  215.  
  216.  
  217. FIN.BAT
  218. ───────
  219.     
  220.     Well, major addition to the flexibility of FileIN!. You can now scan
  221.     inbound SDN files for virii, insert BBS comments, and import the
  222.     FILE_ID.DIZ or DESC.SDI inside an archive if it exists.
  223.  
  224.     Setting it all up is quite simple. You make a batch file, filename is
  225.     FIN.BAT, and use that to perform all desired operations. Two parameters
  226.     are passed to FIN.BAT, %1 is the complete path+filename and extension.
  227.     %2 is the extension only. %1 is used for the DIZ file extraction, you
  228.     can do something like this in the batch file.
  229.  
  230. if %2=ZIP then pkunzip %1 FILE_ID.DIZ DESC.SDI
  231. if %2=ARJ then ARJ e %1 FILE_ID.DIZ DESC.SDI
  232.  
  233.     etc etc. You can add as many archivers as you want.
  234.  
  235.     You may also run SCAN, TBAV or THDPRO on the archive, and if it contains a
  236.     virus, you may delete it by simply doing a DEL %1. After FIN.BAT has
  237.     finished, if the file no longer exists it is skipped and operation continues
  238.     as normal. Two sample batch files are included, one requires THDPRO to be
  239.     installed on your system. If you DON'T have THDPRO, consider installing it,
  240.     it's an excellent package!  Remember that even though the sample batch
  241.     files are named SAMPLE1.BAT and SAMPLE2.BAT, you will STILL need to
  242.     name your batch file FIN.BAT (or FIN.BTM for 4dos or nDos users).
  243.  
  244. Restriction on FIN.BAT
  245. ──────────────────────
  246.     When extracting .DIZ or DESC.SDI files, they MUST be extracted to the
  247.     current directory. You can use the lines above in your batch file, or,
  248.     if you have GUS you can do this
  249.  
  250.     GUS %1 FILE_ID.DIZ DESC.SDI
  251.  
  252.     As far as scanning is concerned...if you delete the file(del %1) when
  253.     filein returns from running the batch file, it will skip the entry if
  254.     the file no longer exists.
  255.  
  256.     FIN.BAT or FIN.BTM(4dos batch) must exist either in the current
  257.     directory or in a directory in your PATH statement. Swapping to run
  258.     FIN.BAT is disabled if toggle 'Run FIN.BAT' is no in the options menu, or
  259.     the swap path you specified cannot be located.
  260.  
  261.     You need to give filein as much ram as possible. Certain compressors,
  262.     like ARJ, require large amounts of ram for initialization. If you
  263.     decide to run THDPRO in your batch file, you'll need even more. FileIN!
  264.     does swap, however I'd say 200k at the absolute minimum, more(around
  265.     420+) would be ideal. The swap routines have been known to blow up if
  266.     they run out of ram, so if filein locks, try to free up more memory.
  267.  
  268.     Minor Glitch fixes, etc etc. Overall, its much more stable than before.
  269.  
  270. Ignore Mode
  271. ───────────
  272.  
  273.     Ignore mode is a special mode that filein can use to import a files.bbs
  274. that does not have the files listed in the files.bbs. If you say, had a list
  275. of files that you intended to download in several parts, but got the files.bbs
  276. early..you could import the files, using ignore mode. The ignore mode sets
  277. ALL imported files to "Offline Request" status in renegade. When/if the files
  278. you are expecting come in, renegade can fix the offline status with a cmdkey
  279. *5.
  280.  
  281. Special Precautions
  282. ───────────────────
  283.     FileIN! is now fully multi-node capable. I have been able to run it under
  284.     DesqView/X with 3 windows open, two running renegade, with no problems.
  285.     However, you should still make freqent backups of crucial data
  286.     (the \DATA or \GFILES directory is of utmost importance). 
  287.  
  288. Bugs + Suggestions
  289. ──────────────────
  290.     I have tested FileIN! to the best of my ability, however with my
  291.     fairly rushed schedule I'm not going to promise that its perfect. I
  292.     haven't had any problems reported by the testing sites, but if you do
  293.     come across a problem, document it including if applicable the runtime
  294.     error number, and the address, ex 0000:FFE7.
  295.  
  296.     Runtime errors are now trapped in a file called FILEIN.ERR. If you have
  297.     a runtime error, send this file to Patrick, his BBS #/network addresses
  298.     are at the bottom of this document.
  299.  
  300.     I owe a LOT to many people for testing, particularly Patrick
  301.     Spence(gave me the idea for FIN.BAT), Steve Zapatka(loyal tester), Dan
  302.     Jones, Joe Farrell, Richard Rector, Frank Ward, Fred Cohen, and
  303.     countless others who have expressed interest and have helped test the
  304.     beta versions. Thanks to all.
  305.  
  306.  
  307. Legal Stuff
  308. ───────────
  309.     FileIN! is *FREE*. Yes, something for nothing, like all my utils. I am
  310.     not under ANY circumstances responsible for damage to ANYTHING that
  311.     results from the use or misuse of FILEIN.EXE, FILECFG.EXE, or any
  312.     associated files that are used with filein. Please read REGISTER.DOC,
  313.     but your only investment will be a postcard. You NEED to send that
  314.     postcard if you plan on using the new features, as this version of
  315.     FileIN! will only run fully with a valid serial number.
  316.  
  317.     FileIN! is Copyrighted material by Chris Roberts and Patrick Spence,
  318.     you are given permission to reproduce and distribute the main ARCHIVE
  319.     (ZIP, ARJ, or whatever format it's in) as long as the original contents
  320.     are NOT altered in ANY way. You may NOT charge for the distribution of
  321.     this file other than a disk duplication/postage charge. You may NOT
  322.     add, remove, or modify files from the original archive created by Chris
  323.     Roberts. You may NOT place FileIN! in a collection of utilites being
  324.     sold for profit(example, placing FileIN! on a CD-ROM for sale to sysops)
  325.     without prior written consent by Chris Roberts or Patrick Spence. My
  326.     address is in UPDATE.DOC, contact me if necessary. Permission for this
  327.     type of distribution is not a hassle and can usually be faxed out to you
  328.     within a day of receipt of your request.
  329.  
  330.     This program uses a customized version of Ralf Brown's SPAWNO routines
  331.     to minimize memory use while running other programs or shelling to
  332.     DOS. Might I add its a darn good swapper routine :)
  333.  
  334.     Special thanks to Patrick Spence of Hawk's Aerie, Fred Cohen of
  335.     DemoSoft, and Steve Zapatka of Crazy BBS for testing the program and
  336.     reporting bugs.
  337.  
  338. Bug Reports
  339. ───────────
  340.     Bug reports should be sent to Chris Roberts.  Various methods of
  341.     contact are:
  342.         
  343.         Email: halatos@azbiz.net
  344.         WWW  : http://www.azbiz.net/~halatos
  345.  
  346.     Note, my BBS is no longer up to the public , and I am no longer a member 
  347.     of ITCnet(or any net for that matter) :)
  348.     
  349. And keep in mind, my email box is always open and waiting for suggestions
  350. and problem reports.
  351.